Add Macaroon token support - #2200
Open
sdelamo wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds an optional Micronaut Security module that supports Macaroon bearer tokens (generation + validation) using jmacaroons, along with documentation and build integration.
Changes:
- Introduces
security-macaroonsGradle submodule with generator/validator implementations and supporting APIs. - Adds configuration properties, encoding/decoding of claims as first-party caveats, and default authentication/claims factories.
- Documents setup, configuration, usage patterns, and caveat verification.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/docs/guide/toc.yml | Adds “Macaroons” entry to authentication strategies TOC |
| src/main/docs/guide/authenticationStrategies/macaroons.adoc | New guide page describing module usage and security notes |
| settings.gradle | Registers the new security-macaroons subproject |
| gradle/libs.versions.toml | Adds managed jmacaroons dependency version/catalog entry |
| security-macaroons/build.gradle.kts | New submodule build config and dependencies |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/package-info.java | Declares package docs and @NullMarked default |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonTokenValidator.java | Implements TokenValidator<HttpRequest<?>> for Macaroons |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonTokenGenerator.java | Implements TokenGenerator for Macaroon tokens |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonSerializers.java | Maps Micronaut enum to jmacaroons serializers |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonSerialization.java | Introduces supported serialization enum |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonConfigurationProperties.java | Adds config properties for macaroons (secret, formats, caveats, toggles) |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonConfiguration.java | Defines configuration interface contract |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonClaimsCodec.java | Encodes/decodes claims into first-party caveat strings |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonCaveatVerifier.java | Public SPI for custom caveat verification |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonCaveat.java | Public value type representing a first-party caveat |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonAuthenticationFactory.java | Public SPI to build Authentication from verified context |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/MacaroonAuthenticationContext.java | Public context object passed to authentication factory |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/DefaultMacaroonClaimsGenerator.java | Adds a default ClaimsGenerator implementation for macaroons |
| security-macaroons/src/main/java/io/micronaut/security/token/macaroons/DefaultMacaroonAuthenticationFactory.java | Default implementation of MacaroonAuthenticationFactory |
| security-macaroons/src/test/java/io/micronaut/security/token/macaroons/MacaroonTokenValidatorTest.java | Adds unit/integration tests for generator/validator behavior |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
micronaut-security-macaroonsmodule backed byjmacaroonswithout exposing jmacaroons types in public Micronaut APIs.TokenGeneratorandTokenValidator<HttpRequest<?>>contracts, with explicit root-secret activation and fail-closed first-party caveat handling.Verification
./gradlew :micronaut-security-macaroons:check./gradlew :micronaut-security:test --tests 'io.micronaut.security.token.TokenAuthenticationFetcherSpec' docsgit diff --check -- settings.gradle gradle/libs.versions.toml security-macaroons src/main/docs/guide/authenticationStrategies/macaroons.adoc src/main/docs/guide/toc.ymlPR Assets
No external rendered assets are required for this change.
Fixes #819
✨ This message was AI-generated using gpt-5.3-codex